<?php
 /**
 * Clips for Coda
 * 
 * This explains the clips for coda tool that
 * 
 * @editing     This page is specific to CI Docs documentation, therefor should not be edited
 * @url     /tools/clips_for_coda
 */
?>

<h1><?php echo $title; ?></h1>

<p>We use <a href="http://www.panic.com/coda" target="_blank" title="Visit Coda's website">Panic's Coda</a> as our main PHP/HTML editor. So as an added benefit to help make documentation even easier we wrote some common clips for CI Docs. We have included a lot of useful clips and you can modify or delete them as you please. Below is a table of reference for the clips.</p>

<p>Download the clips set from <a href="http://code.google.com/p/cidocs/downloads/list" target="_blank">our Google Code page</a></p>

<h2>CI Docs Clips for Coda v0.1</h2>

<table class="table">
	<thead>
		<tr>
			<th class="nowrap" title="(KEY + TAB)">TAB Identifier</th>
			<th>Code Summary</th>
			<th>Description</th>
			<th>Sample</th>
		</tr>
	</thead>
	<tbody>
		<tr>
			<td><strong>title</strong></td>
			<td>&lt;h1&gt;&lt;?php echo $title; ?&gt;&lt;/h1&gt;</td>
			<td>Used for titles of topics you are on. Will auto fill based on TOC input.</td>
			<td><h1><?php echo $title; ?></h1></td>
		</tr>
		<tr>
			<td><strong>note</strong></td>
			<td>&lt;p class="note"&gt;&lt;strong&gt;Note:&lt;/strong&gt; *&lt;/p&gt;</td>
			<td>Default Note block</td>
			<td><p class="note"><strong>Note:</strong> Please advise</p></td>
		</tr>
		<tr>
			<td><strong>important</strong></td>
			<td class="nowrap">&lt;p class="important"&gt;&lt;strong&gt;Important:&lt;/strong&gt; *&lt;/p&gt;</td>
			<td>Default Important block</td>
			<td><p class="important"><strong>Important:</strong> Don't ignore this</p></td>
		</tr>
		<tr>
			<td><strong>h1</strong></td>
			<td>&lt;h1&gt;*&lt;/h1&gt;</td>
			<td>Used for the topic title.</td>
			<td><h1>Page Title</h1></td>
		</tr>
		<tr>
			<td><strong>h2</strong></td>
			<td>&lt;h2&gt;*&lt;/h2&gt;</td>
			<td>Used for usage headings.</td>
			<td><h2>Usage Heading</h2></td>
		</tr>
		<tr>
			<td><strong>h3</strong></td>
			<td>&lt;h3&gt;*&lt;/h3&gt;</td>
			<td>Used for sub-headings.</td>
			<td><h3>Sub-heading</h3></td>
		</tr>
		<tr>
			<td><strong>p</strong></td>
			<td>&lt;p&gt;*&lt;/p&gt;</td>
			<td>Creates a default paragraph.</td>
			<td><p>Paragraph of text</p></td>
		</tr>
		<tr>
			<td><strong>a</strong></td>
			<td>&lt;a href="*"&gt;&lt;/a&gt;</td>
			<td>Creates a default hyperlink.</td>
			<td><a href="#">Some Link</a></td>
		</tr>
		<tr>
			<td><strong>abbr</strong></td>
			<td>&lt;abbr title="*"&gt;&lt;/abbr&gt;</td>
			<td>Mark something as an abbreviation</td>
			<td><abbr title="Table of Contents">TOC</abbr></td>
		</tr>
		<tr>
			<td><strong>dfn</strong></td>
			<td>&lt;dfn&gt;*&lt;/dfn&gt;</td>
			<td>Used for highlighting code.</td>
			<td>Uses a <dfn>&lt;dfn&gt;</dfn> tag</td>
		</tr>
		<tr>
			<td><strong>var</strong></td>
			<td>&lt;var&gt;*&lt;/var&gt;</td>
			<td>Used for hilighting vars.</td>
			<td>Pass in <var>$data</var></td>
		</tr>
		<tr>
			<td><strong>kbd</strong></td>
			<td>&lt;kbd&gt;*&lt;/kbd&gt;</td>
			<td>Used for emphasis.</td>
			<td><kbd>DON'T</kbd> forget again</td>
		</tr>
		<tr>
			<td><strong>code</strong></td>
			<td>&lt;code&gt;*&lt;/code&gt;</td>
			<td>For single or small lines of code. Is not preformatted.</td>
			<td><code>echo 'Hello World!';</code></td>
		</tr>
		<tr>
			<td><strong>pre</strong></td>
			<td>&lt;pre&gt;*&lt;/pre&gt;</td>
			<td>For larger blocks of code that aren't using color syntax. Preformatted.</td>
			<td><pre>echo 'Hello preformatted World!';</pre></td>
		</tr>
		<tr>
			<td><strong>strong</strong></td>
			<td>&lt;strong&gt;*&lt;/strong&gt;</td>
			<td>Bolds text</td>
			<td>This coffee is <strong>strong</strong></td>
		</tr>
		<tr>
			<td><strong>em</strong></td>
			<td>&lt;em&gt;*&lt;/em&gt;</td>
			<td>Italicizes text</td>
			<td>That's what <em>she</em> said</td>
		</tr>
		<tr>
			<td><strong>ol</strong></td>
			<td>&lt;ol&gt; &lt;li&gt;*&lt;/li&gt; &lt;li&gt;&lt;/li&gt; &lt;/ol&gt;</td>
			<td>Creates a 2 item Ordered List</td>
			<td><ol>
				<li>Item 1</li>
				<li>Item 2</li>
			</ol></td>
		</tr>
		<tr>
			<td><strong>ul</strong></td>
			<td>&lt;ul&gt; &lt;li&gt;*&lt;/li&gt; &lt;li&gt;&lt;/li&gt; &lt;/ul&gt;</td>
			<td>Creates a 2 item Unordered List</td>
			<td><ul>
				<li>Item 1</li>
				<li>Item 2</li>
			</ul></td>
		</tr>
		<tr>
			<td><strong>li</strong></td>
			<td>&lt;li&gt;*&lt;/li&gt;</td>
			<td>Creates a list item for UL or OL.</td>
			<td><ul><li>Manually inserted item</li></ul></td>
		</tr>
		<tr>
			<td><strong>table</strong></td>
			<td>&lt;table class="table"&gt; ... &lt;/table&gt;</td>
			<td>Creates a table with THEAD and TBODY, 4 cols, 2 rows</td>
			<td>This table uses table</td>
		</tr>
		<tr>
			<td><strong>thead</strong></td>
			<td>&lt;thead&gt; &lt;tr&gt; &lt;th&gt;*&lt;/th&gt; &lt;th&gt;&lt;/th&gt; &lt;/tr&gt; &lt;/thead&gt;</td>
			<td>Creates a THEAD with 2 cols</td>
			<td></td>
		</tr>
		<tr>
			<td><strong>tbody</strong></td>
			<td>&lt;tbody&gt; &lt;tr&gt; &lt;td&gt;*&lt;/td&gt; &lt;td&gt;&lt;/td&gt; &lt;/tr&gt; &lt;/tbody&gt;</td>
			<td>Creates a TBODY with 2 cols</td>
			<td></td>
		</tr>
		<tr>
			<td><strong>tr</strong></td>
			<td>&lt;tr&gt; &lt;td&gt;&lt;strong&gt;*&lt;/strong&gt;&lt;/td&gt; &lt;td&gt;&lt;/td&gt; &lt;/tr&gt;</td>
			<td>Creates a TR with 2 cols, first one is bold</td>
			<td></td>
		</tr>
		<tr>
			<td><strong>td</strong></td>
			<td>&lt;td&gt;*&lt;/td&gt;</td>
			<td>Creates a TD</td>
			<td></td>
		</tr>
		<tr>
			<td><strong>lt</strong></td>
			<td>&amp;lt;</td>
			<td>Creates an html entity for &lt;</td>
			<td>&lt;</td>
		</tr>
		<tr>
			<td><strong>gt</strong></td>
			<td>&amp;gt;</td>
			<td>Creates an html entity for &gt;</td>
			<td>&gt;</td>
		</tr>
		<tr>
			<td><strong>tag</strong></td>
			<td>&amp;lt;*&amp;gt;</td>
			<td>Creates a safe &lt;tag&gt; for use in CODE and PRE.</td>
			<td>&lt;tag&gt;</td>
		</tr>
		<tr>
			<td><strong>/tag</strong></td>
			<td>&amp;lt;/*&amp;gt;</td>
			<td>Creates a safe closing &lt;/tag&gt; for use in CODE and PRE.</td>
			<td>&lt;/tag&gt;</td>
		</tr>
		<tr>
			<td><strong>color syntax</strong></td>
			<td>&lt;?php $this-&gt;docs-&gt;color_syntax(); ?&gt;</td>
			<td>Creates the code to call the color_syntax() function</td>
			<td><?php $this->docs->color_syntax(); ?></td>
		</tr>
		<tr>
			<td><strong>pre php</strong></td>
			<td>&lt;pre class="brush: php"&gt;*&lt;/pre&gt;</td>
			<td>Creates a PRE tag with the PHP color syntax mode</td>
			<td><pre class="brush: php">
			echo 'Hello World!';
			</pre></td>
		</tr>
		<tr>
			<td><strong>pre js</strong></td>
			<td>&lt;pre class="brush: js"&gt;*&lt;/pre&gt;</td>
			<td>Creates a PRE tag with the JavaScript color syntax mode</td>
			<td><pre class="brush: js">
			var hello = 'world'; document.write(hello);
			</pre></td>
		</tr>
		<tr>
			<td><strong>pre css</strong></td>
			<td>&lt;pre class="brush: css"&gt;*&lt;/pre&gt;</td>
			<td>Creates a PRE tag with the CSS color syntax mode</td>
			<td><pre class="brush: css">
			.bold { font-weight: bold }
			</pre></td>
		</tr>
		<tr>
			<td><strong>pre html</strong></td>
			<td>&lt;pre class="brush: html"&gt;*&lt;/pre&gt;</td>
			<td>Creates a PRE tag with the HTML color syntax mode</td>
			<td><pre class="brush: html">
			&lt;a href="#"&gt;We're going nowhere&lt;/a&gt;
			</pre></td>
		</tr>
		<tr>
			<td><strong>link</strong></td>
			<td>&lt;?php echo $this-&gt;toc-&gt;link('*', ''); ?&gt;</td>
			<td>Creates a link within the documentation</td>
			<td><?php echo $this->toc->link('tools/clips_for_coda', 'Clips for Coda'); ?></td>
		</tr>
		<tr>
			<td><strong>version link</strong></td>
			<td>&lt;?php echo $this-&gt;toc-&gt;version_link('*', '', ''); ?&gt;</td>
			<td>Creates a link to a specific version of a topic</td>
			<td><?php echo $this->toc->version_link('v1.0', 'tools/clips_for_coda', 'Initial Release of this topic (v1.0)'); ?></td>
		</tr>
		<tr>
			<td><strong>guide link</strong></td>
			<td>&lt;?php echo $this-&gt;toc-&gt;guide_link('*', '', ''); ?&gt;</td>
			<td>Creates a link to another guide on the CI Docs installation</td>
			<td><?php echo $this->toc->guide_link('Themes', 'Themes Library'); ?></td>
		</tr>
		<tr>
			<td><strong>toc start</strong></td>
			<td>$this->toc->start() ... ->end()</td>
			<td>Creates the basic structure of the toc with common cateogries and topics</td>
			<td></td>
		</tr>
		<tr>
			<td><strong>toc col</strong></td>
			<td>->col()</td>
			<td>Creates a new col for the toc</td>
			<td></td>
		</tr>
		<tr>
			<td><strong>toc cat</strong></td>
			<td>->category('*', '')</td>
			<td>Creates a new category for the toc</td>
			<td></td>
		</tr>
		<tr>
			<td><strong>toc item</strong></td>
			<td>->item('*', '')</td>
			<td>Creates a new item for the toc</td>
			<td></td>
		</tr>
	</tbody>
</table>

<p class="note"><strong>Note:</strong> The <dfn>*</dfn> indicates the insertion point</p>

<p class="important"><strong>Important:</strong> Some of the identifier names are very common and may collide with previous set clips</p>